Table
Type
widget
Description
Table widgets allow you to display sets of data. Tables display information in a way that is easy to scan, so users can look for patterns and information.
Children Properties
Property
| Name | Summary | Syntax |
|---|---|---|
| usePagination | Defines if pagination is used in the table. | get the usePagination of <widget> set the usePagination of <widget> to {true | false} |
| fillEmptyRows | Set to true to fill with empty rows. | get the fillEmptyRows of <widget> set the fillEmptyRows of <widget> to {true | false} |
| hTableGrid | Defines if the horizontal lines are shown. | get the hTableGrid of <widget> set the hTableGrid of <widget> to {true | false} |
| columnType | Returns the data type of the column. | get the columnType[index] of <widget> set the columnType[index] of <widget> to {text|svg-LCname|imageData|imageFile|color|boolean|autoIncrement} |
| editableColumn | Defines if the user can edit the cells of this column. | get the editableColumn[pColumnNumber] of <widget> set the editableColumn[pColumnNumber] of <widget> to {true | false} |
| columnLabels | Specifies the text to show on top of columns. Examples:set the columnLabels of widget "Table" to "Product,Icon,Description" | get the columnLabels of <widget> set the columnLabels of <widget> to <"CommaDelimitedList"> |
| rowHeight | Set the height of rows. | get the rowHeight of <widget> set the rowHeight of <widget> to <integer> |
| headerDividers | Set to true to show header dividers. | get the headerDividers of <widget> set the headerDividers of <widget> to {true | false} |
| headerTextStyle | This property creates a lift effect on the z axis. | get the headerTextStyle of <widget> set the headerTextStyle of <widget> to {plain|bold|italic|bold,italic} |
| alternateRowColors | Defines whether to use alternate row colors. | get the alternateRowColors of <widget> set the alternateRowColors of <widget> to {true | false} |
| sortByColumn | Define the number of the column by which the data in the table is sorted. | get the sortByColumn of <widget> set the sortByColumn of <widget> to <integer> |
| tableLineSize | Specifies the thickness with which the inner lines and borders of the Table are drawn. | get the tableLineSize of <widget> set the tableLineSize of <widget> to <integer> |
| rowsPerPageOptions | Customizes the options of the rows per page select field. Examples:set the rowsPerPageOptions of widget "table" to 10 & cr & 15 & cr & -1, "All" | get the rowsPerPageOptions of <widget> set the rowsPerPageOptions of <widget> to <string> |
| label | The label of the table | get the label of <widget> set the label of <widget> to <string> |
| vTableGrid | Defines if the vertical lines are shown. | get the vTableGrid of <widget> set the vTableGrid of <widget> to {true | false} |
| rowsNumber | Gets the total number of rows in the table | get the rowsNumber of <widget> |
| dataArray | Get or set the data array that the Table will display. | get the dataArray of <widget> set the dataArray of <widget> to <pDataArray> |
| rowAlternateColor | Specifies the fill color of alternate rows when property is true. | get the rowAlternateColor of <widget> set the rowAlternateColor of <widget> to <RGBA Color> |
| pagesNumber | The total number of pages the table has. | get the pagesNumber of <widget> |
| headerTextColor | Specifies the color of the table header text. | get the headerTextColor of <widget> set the headerTextColor of <widget> to <RGB Color> |
| showHeader | Specifies if the Table widget will show the column header | get the showHeader of <widget> set the showHeader of <widget> to {true | false} |
| tablePadding | Specifies the padding that the table cells will have. | get the tablePadding of <widget> set the tablePadding of <widget> to <integer> |
| rowColor | Specifies the fill color of rows. | get the rowColor of <widget> set the rowColor of <widget> to <RGBA Color> |
| tablePage | The current page number of the table when paging is used. | get the tablePage of <widget> set the tablePage of <widget> to <integer> |
| roundedRadius | The radius of the corners of the widget. | get the roundedRadius of widget set the roundedRadius of widget to <integer> |
| rowsPerPage | Defines the number of rows per page. | get the rowsPerPage of <widget> set the rowsPerPage of <widget> to {<integer>} |
| tableText | Specify the data that will be displayed in the table. | set the tableText of <widget> to <theText> |
| headerLineColor | Sets the color of the table column header dividers. | get the headerLineColor of <widget> set the headerLineColor of <widget> to <RGBA Color> |
| fixedFirstCol | Defines if the first column stays fixed when scrolling horizontally. | get the fixedFirstCol of <widget> set the fixedFirstCol of <widget> to {true | false} |
| hilitedRows | Specifies the line(s) that will be hilited on a Table control. Examples:set the hilitedRow of widget "table" to "1,2,9" | get the hilitedRows of <widget> set the hilitedRows of <widget> to {<Number>|<List>} |
| columnSortType | The column sort type. | get the columnSortType[index] of <widget> set the columnSortType[index] of <widget> to {none|international|numeric|dateTime|text|binary} |
| showLabel | Whether or not to display a label for the table. | set the showLabel of <widget> to {true|false} get the showLabel of <widget> |
| tableHScrollBar | Controls the visibility of the table's horizontal scrollbar. | get the tableHScrollBar of <widget> set the tableHScrollBar of <widget> to <{"on" | "off" | "auto"}> |
| themeData | The theme mappings of this widget | set the themeData of <widget> to {<array>} get the themeData of <widget> |
| multiHilite | Specifies if the table widget will allow to select more than one row at the same time | get the multiHilite of <widget> set the multiHilite of <widget> to {true | false} |
| headerColor | Defines the background color of the table column header. | get the headerColor of <widget> set the headerColor of <widget> to <RGBA Color> |
| deleteColumnByNumber | Delete a column by index. Examples:set the deleteColumnByNumber of widget "table" to 4 | set the deleteColumnByNumber of <widget> to {true | false} |
| columnNames | Specifies the names of columns. Examples:set the columnNames of widget "Table" to "Product,Icon,Description" | get the columnNames of <widget> set the columnNames of <widget> to <Comma-Delimited-List> |
| autoHilited | Specifies if the table widget will respond to mouse events | get the autoHilited of <widget> set the autoHilited of <widget> to {true | false} |
| headerHeight | Set the height of columns header. | get the headerHeight of <widget> set the headerHeight of <widget> to <integer> |
| search | Show or not the search field. | set the search of <widget> to {true|false} get the search of <widget> |
| headerTextSize | The headerTextSize of a Table defines the height of the text of its header. | get the headerTextSize of <widget> set the headerTextSize of <widget> to <integer> |
| hilitedTextColor | The color used to draw the text and icons in the table when they are highlighted. | get the hilitedTextColor of <widget> set the hilitedTextColor of <widget> to <RGBA Color> |
| tableVScrollBar | Controls the visibility of the table's vertical scrollbar. | get the tableVScrollBar of <widget> set the tableVScrollBar of <widget> to <{"on" | "off" | "auto"}> |
| touchScrolling | Specifies if the table widget will respond to mouse scrolling gestures | get the touchScrolling of <widget> set the touchScrolling of <widget> to {true | false} |
| TableColumns | Get or set the data array that the Table uses to build columns. | get the TableColumns of <widget> set the TableColumns of <widget> to <columnsArray> |
| columnWidths | Specifies the width for each column. Examples:set the columnWidths of widget "Table" to "200,100,300" | get the columnWidths of <widget> set the columnWidths of <widget> to <integer> |
| mouseHoverHilite | Selects the mouse row when the mouse is moved | get the mouseHoverHilite of <widget> set the mouseHoverHilite of <widget> to {true | false} |
Message
| Name | Summary | Syntax |
|---|---|---|
| pageChanged | This message is triggered when the page is changed. | pageChanged <pPage>, <pPreviousPage> |
| headerClick | This message is sent when the table header is clicked. | headerClick <pColumnNumber> |
| columnBeginResize | This message is sent when a column resize is initiated. | columnBeginResize <pColumnNumber> |
| columnEndResize | This message is sent when a column is finished resizing. | columnEndResize <pColumnNumber> |
| cellDoubleClick | sent when the mouse button is released at the end of a double-click on the same cell. | columnEndResize <pColumnNumber>, <pRowNumber>, <pCellRect> |
| contentChange | Sent when the content of the table is modified. | contentChange |